Improve doc of gtk_text_tag_table_remove()
authorSébastien Wilmet <swilmet@gnome.org>
Mon, 5 Aug 2013 18:37:54 +0000 (20:37 +0200)
committerSébastien Wilmet <swilmet@gnome.org>
Mon, 5 Aug 2013 21:01:37 +0000 (23:01 +0200)
It's obvious, but it's better to say it.

https://bugzilla.gnome.org/show_bug.cgi?id=705529

gtk/gtktexttagtable.c

index 6c9e500c5df86c68f65965f57d8f7087236f08f1..571fdf8dcb6c5853839773995aeef3f85690bcf3 100644 (file)
@@ -310,10 +310,11 @@ gtk_text_tag_table_lookup (GtkTextTagTable *table,
  * gtk_text_tag_table_remove:
  * @table: a #GtkTextTagTable
  * @tag: a #GtkTextTag
- * 
- * Remove a tag from the table. This will remove the table's
- * reference to the tag, so be careful - the tag will end
- * up destroyed if you don't have a reference to it.
+ *
+ * Remove a tag from the table. If a #GtkTextBuffer has @table as its tag table,
+ * the tag is removed from the buffer. The table's reference to the tag is
+ * removed, so the tag will end up destroyed if you don't have a reference to
+ * it.
  **/
 void
 gtk_text_tag_table_remove (GtkTextTagTable *table,